Fix schema generation for $ref with sibling description (OpenAPI 3.1) - #381
Merged
jemacineiras merged 1 commit intoJul 23, 2026
Merged
Conversation
OpenAPI 3.1 / JSON Schema 2020-12 allow sibling keywords (e.g. `description`) next to `$ref`, and their ordering is not significant. `ApiTool.hasRef` only treated a node as a reference when `$ref` was the *first* field, so a property declaring `description` before `$ref` was not recognised as a reference: it fell through to the basic-type branch and generated a field with an empty type, breaking generation. `hasRef` now detects a top-level `$ref` regardless of field ordering. Adds a regression test (`testRefWithDescription`) covering both orderings. Bumps version 6.4.1 -> 6.4.2. Closes #1 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Up to standards ✅🟢 Issues
|
| Metric | Results |
|---|---|
| Complexity | 0 |
| Duplication | 0 |
NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.
jemacineiras
approved these changes
Jul 23, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
In OpenAPI 3.1 / JSON Schema 2020-12 a
$refmay carry sibling keywords such asdescription, and their ordering is not significant. When a property combines$ref+description, schema generation breaks and produces a field with an empty type (or fails).Root cause
ApiTool.hasRefonly treated a node as a reference when$refwas the first field:If
descriptionappears before$ref(the usual ordering),hasRefreturnsfalse, the node falls through to theisBasicTypebranch and a field with an empty type is generated.Changes
hasRefnow detects a top-level$refregardless of field ordering.testRefWithDescriptioncovering both orderings (descriptionbefore and after$ref), with its assets.6.4.1→6.4.2(engine, maven-plugin, gradle-plugin).Verification
multiapi-engineOpenAPI generator suite: 51/51 passing on top ofmain(mvn test -Dtest=OpenApiGeneratorTest#processFileSpec).Example that reproduces the bug
🤖 Generated with Claude Code